DOCSP-43494-copilot-docs-command #96

ltran-mdb2 · 2024-10-01T17:41:21Z

DESCRIPTION

Adding page on /docs command with the VSCode Copilot Participant

STAGING

https://deploy-preview-96--docs-mongodb-vscode.netlify.app/copilot/
https://deploy-preview-96--docs-mongodb-vscode.netlify.app/copilot-docs/

JIRA

https://jira.mongodb.org/browse/DOCSP-43494

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Is this free of spelling errors?
Is this free of grammatical errors?
Is this free of staging / rendering issues?
Are all the links working?

External Review Requirements

What's expected of an external reviewer?

netlify · 2024-10-01T17:41:37Z

✅ Deploy Preview for docs-mongodb-vscode ready!

Name	Link
🔨 Latest commit	`5e0bc95`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-mongodb-vscode/deploys/6706efcb1ee7a40008ad9746
😎 Deploy Preview	https://deploy-preview-96--docs-mongodb-vscode.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 44 (🟢 up 4 from production) Accessibility: 91 (no change from production) Best Practices: 75 (no change from production) SEO: 69 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

jeff-allen-mongo

@ltran-mdb2 thanks for this update! This looks solid so far - just have some wording nits and suggestions for your consideration.

jeff-allen-mongo · 2024-10-01T18:37:47Z

source/copilot-docs.txt

+   :depth: 1
+   :class: singlecol
+
+The ``/docs`` command provides MongoDB specific information to users,


[Suggestion]

I think "MongoDB specific" should be hyphenated:

Suggested change

The ``/docs`` command provides MongoDB specific information to users,

The ``/docs`` command provides MongoDB-specific information to users,

jeff-allen-mongo · 2024-10-01T18:39:07Z

source/copilot-docs.txt

+   :depth: 1
+   :class: singlecol
+
+The ``/docs`` command provides MongoDB specific information to users,


[Question]

Do we need to say "to users"? If we omit, this is more minimal and I think becomes slightly clearer that we're talking to the reader.

source/copilot-docs.txt

jeff-allen-mongo · 2024-10-01T18:40:47Z

source/copilot-docs.txt

+The ``/docs`` command provides MongoDB specific information to users,
+supplemented by links to MongoDB Documentation. The |copilot| is
+knowledgeable of the latest MongoDB Documentation and uses the
+MongoDB Docs Chatbot API to link users to information in addition to


[Nit]

Similar to my previous comment, the use of "users" here feels a little strange to me, since our docs are typically written in the second person. Maybe we can drop "users" here as well?

jeff-allen-mongo · 2024-10-01T18:41:12Z

source/copilot-docs.txt

+the textual response. 
+
+Example
+~~~~~~~


[Nit]

Since this is an h1 heading, let's use dash underlines -

jeff-allen-mongo · 2024-10-01T18:41:29Z

source/copilot-docs.txt

+supplemented by links to MongoDB Documentation. The |copilot| is
+knowledgeable of the latest MongoDB Documentation and uses the
+MongoDB Docs Chatbot API to link users to information in addition to
+the textual response. 


Suggestion:

Suggested change

the textual response.

the text response.

jeff-allen-mongo · 2024-10-01T18:41:58Z

source/copilot-docs.txt

+Consider the following prompt that asks for information on creating an
+index in the GitHub Copilot chat:


[Nit, minimalism]

Suggested change

Consider the following prompt that asks for information on creating an

index in the GitHub Copilot chat:

The following prompt asks for information on creating an

index in the GitHub Copilot chat:

jeff-allen-mongo · 2024-10-01T18:43:38Z

source/copilot-docs.txt

+Consider the following prompt that asks for information on creating an
+index in the GitHub Copilot chat:
+
+.. code-block:: javascript


To avoid the weird syntax highlighting in the code blocks, maybe try .. code-block:: none here. Same comment applies to the response code-block further down.

Thanks for this suggestion! I also updated the /query page to use the none type to avoid the weird syntax highlighting

jeff-allen-mongo · 2024-10-01T18:45:07Z

source/copilot-docs.txt

+.. figure:: /images/copilot-docs.png
+   :figwidth: 700px
+   :alt: Screenshot of copilot providing information on creating an index


I'm not sure we need the screenshot here, if it's just showing what we've described above?

I'll check in with Garaub about this one - he originally asked for screenshots on the /query page to illustrate the UI

Sounds good - happy to leave in if it's a PM request :)

@GaurabAryal do you have preference here?

Yeah i think since this is such a new product, it is better to have the visuals in the docs. Let's keep it for now.

jeff-allen-mongo

LGTM % an optional small comment. Thanks @ltran-mdb2!

jeff-allen-mongo · 2024-10-02T15:17:51Z

source/copilot-docs.txt

+- `Getting Started with MongoDB and Java - CRUD Operations Tutorial <https://www.mongodb.com/developer/languages/java/java-setup-crud-operations>`__
+- `db.collection.createIndex() <https://mongodb.com/docs/manual/reference/method/db.collection.createIndex/>`__
+
+The |copilot| also returns a textual response with information about


[Minor]

To be consistent with the previous patch, let's maybe also edit to "text response" here.

Suggested change

The |copilot| also returns a textual response with information about

The |copilot| also returns a text response with information about

Anemy

lgtm, left two small suggestions, not blockers.
A heads up, we are going to structure the reference links a bit differently soon, moving them after the content and maybe also using the built in vscode references (which would show up above the content as a dropdown).

Anemy · 2024-10-02T16:42:11Z

source/copilot.txt

 :ref:`/query <vsce-copilot-query>`
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 The ``/query`` command assists in generating queries from a natural


A bit above this, in the paragraph before, we have written:

Through GitHub Copilot's chat feature, users with |vsce| can interact with their MongoDB clusters and generate code with MongoDB domain-specific knowledge on top of GitHub Copilot's LLM.

Should we add something about the MongoDB documentation chatbot there as well?

For the sake of simplicity, I would recommend only mentioning the documentation chatbot on the /docs page

I did add a mention of learning about MongoDB in this section (referring to the /docs command)

Anemy · 2024-10-02T16:43:41Z

source/copilot-docs.txt

+The ``/docs`` command provides MongoDB-specific information,
+supplemented by links to MongoDB Documentation. The |copilot| is
+knowledgeable of the latest MongoDB Documentation and uses the
+MongoDB Docs Chatbot API to link to information in addition to


Suggested change

MongoDB Docs Chatbot API to link to information in addition to

MongoDB Docs Chatbot to link to information in addition to

I don't believe the API is intended for use outside of our use cases; we don't want folks using it at the moment. Maybe we can leave the API part out so folks don't get ideas?

Removed the mention of the API!

GaurabAryal · 2024-10-04T16:28:11Z

source/copilot-docs.txt

+   :class: singlecol
+
+The ``/docs`` command provides MongoDB-specific information,
+supplemented by links to MongoDB Documentation. The |copilot| is


Could we change the second sentence to something like:

For the docs command, the underlying model of the MongoDB Copilot Extension leverages Retrieval-Augmented Generation (RAG) to ensure responses are based on the latest version of MongoDB Documentation.

GaurabAryal · 2024-10-04T16:30:51Z

source/copilot-docs.txt

+MongoDB Docs Chatbot to link to information in addition to
+the text response. 
+
+Example


Is it possible to add a second example here where the docs command recommends a DDP product like vector search or search in the context of "how do I improve the searching speed for query" and it responds with search/vector search recommendation? For vector search we might have to ask something like 'semantic search' in the prompt. This way users know that it can also be leveraged for performance-related questions.

Added a second example that recommends Atlas Vector Search!

GaurabAryal · 2024-10-04T16:31:52Z

source/copilot-docs.txt

+.. figure:: /images/copilot-docs.png
+   :figwidth: 700px
+   :alt: Screenshot of copilot providing information on creating an index


Yeah i think since this is such a new product, it is better to have the visuals in the docs. Let's keep it for now.

GaurabAryal · 2024-10-04T16:33:25Z

source/copilot.txt

+Through GitHub Copilot's chat feature, users with |vsce| can learn about
+MongoDB, interact with their MongoDB clusters, and generate code with
+MongoDB domain-specific knowledge on top of GitHub Copilot's LLM. The
+|copilot| can also answer questions about your database collection


One general comment @ltran-mdb2 – could we switch the wording from MongoDB Github Copilot Participant to MongoDB Extension for Github Copilot? I just confirmed with the team at VS Code that participant isn't the proper branding (more of an implementation detail) and they want us to go with "MongoDB Extension" instead. Sorry for the change in wording!

ltran-mdb2 · 2024-10-09T21:09:35Z

Thanks for your feedback @GaurabAryal ! Could you take another look when you get a chance?

GaurabAryal

This is really great, thanks for all the updates Lauren! 🌟

ltran-mdb2 added 2 commits October 1, 2024 10:44

DOCSP-43493-docs-copilot

2b2bf55

DOCSP-43494-copilot--docs-command

26a17b7

ltran-mdb2 added 2 commits October 1, 2024 13:52

DOCSP-43494-copilot--docs-command

376342b

DOCSP-43494-copilot--docs-command

cf0abce

jeff-allen-mongo reviewed Oct 1, 2024

View reviewed changes

DOCSP-43494 copy edits

3e19dd9

ltran-mdb2 requested a review from jeff-allen-mongo October 2, 2024 15:13

jeff-allen-mongo approved these changes Oct 2, 2024

View reviewed changes

DOCSP-43494 copy edits

294a386

Anemy approved these changes Oct 2, 2024

View reviewed changes

ltran-mdb2 added 2 commits October 3, 2024 11:08

DOCSP-43494 tech edit

efcca3b

DOCSP-43494 tech edit

a03f81f

Anemy approved these changes Oct 4, 2024

View reviewed changes

GaurabAryal suggested changes Oct 4, 2024

View reviewed changes

ltran-mdb2 added 7 commits October 9, 2024 09:48

DOCSP-43494 Gaurab comments

8eef902

DOCSP-43494 adding second docs example

ac86815

DOCSP-43494 adding second docs example

a1ef4be

DOCSP-43494 adding second docs example

9c534af

DOCSP-43494 adding second docs example

c0d8842

DOCSP-43494 adding second docs example

c47a08a

DOCSP-43494 minimalism

5e0bc95

ltran-mdb2 requested a review from GaurabAryal October 9, 2024 21:09

GaurabAryal approved these changes Oct 10, 2024

View reviewed changes

ltran-mdb2 merged commit 88c5f87 into mongodb:master Oct 11, 2024
5 checks passed

ltran-mdb2 mentioned this pull request Oct 15, 2024

DOCSP-44480-copilot-toc-label #99

Merged

5 tasks

	The ``/docs`` command provides MongoDB specific information to users,
	The ``/docs`` command provides MongoDB-specific information to users,

		Consider the following prompt that asks for information on creating an
		index in the GitHub Copilot chat:

	The \|copilot\| also returns a textual response with information about
	The \|copilot\| also returns a text response with information about

	MongoDB Docs Chatbot API to link to information in addition to
	MongoDB Docs Chatbot to link to information in addition to

DOCSP-43494-copilot-docs-command #96

DOCSP-43494-copilot-docs-command #96

Uh oh!

Conversation

ltran-mdb2 commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIPTION

STAGING

JIRA

Self-Review Checklist

External Review Requirements

Uh oh!

netlify bot commented Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-mongodb-vscode ready!

Uh oh!

jeff-allen-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeff-allen-mongo Oct 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jeff-allen-mongo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Anemy left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ltran-mdb2 commented Oct 1, 2024 •

edited

Loading

netlify bot commented Oct 1, 2024 •

edited

Loading

jeff-allen-mongo Oct 1, 2024 •

edited

Loading